DOC: Add comprehensive documentation for TextFileReader class #62579
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…-dev#62357) - Added links to user guide/reshaping in function docstrings - Added cross-references between related functions - Improved example formatting and clarity - Updated docstring formatting per pandas standards
…-dev#62574) - Enhanced TextFileReader class docstring with detailed examples and parameters - Added docstrings to public methods: close(), read(), and get_chunk() - Added TextFileReader methods to API reference (io.rst) - Updated whatsnew for v3.0.0 Closes pandas-dev#62574
|
There are way too many files changed in this PR. Also, it seems generated by AI, and we don't accept AI contributions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds comprehensive documentation for the
TextFileReaderclass and its methods, addressing issue #62574.Changes Made:
TextFileReaderclass docstring with detailed parameters section, comprehensive examples (basic iteration, chunksize usage, and context manager pattern), and cross-references to related functionsclose(): Added docstring explaining resource cleanup with examplesread(): Added docstring with parameters, returns, raises sections, and examplesget_chunk(): Added docstring with parameters, returns, raises sections, and examplesdoc/source/reference/io.rstto includeTextFileReader,TextFileReader.read,TextFileReader.get_chunk, andTextFileReader.closein the API referencedoc/source/whatsnew/v3.0.0.rstdocumenting this improvementDocumentation Improvements:
Closes #62574
Checklist:
class TextFileReadernot documented as a class #62574